scrollbar
Type
object
Summary
A control that indicates a position or setting.
Syntax
scrollbar
Description
Use the scrollbar object type to display the current level or the progress of a task, or to let the user set a level or amount.
A scrollbar can be displayed as a standard scroll bar, a progress bar, or a sliding control, depending on the setting of the scrollbar's style property. Scrollbars can be vertical or horizontal, depending on whether their height or width is greater.
A scrollbar is contained in a card, group, or background. Scrollbars cannot contain other objects.
Examples
set the style of scrollbar "Progress" to progress
if the thumbPosition of scrollbar "Level" > 400 then doOverflow
Related
keyword: templateScrollbar, control
message: scrollbarDrag
object: scrollbar
property: height, width, style
glossary: property, object type
Compatibility and Support
Introduced
LiveCode 1.0
OS
mac
windows
linux
ios
android
Platforms
desktop
server
mobile
Associated Syntax
Message
| Name | Summary | Syntax |
|---|---|---|
| socketError | Sent when an error occurs on a socket that causes the socket to close or to fail to open. | socketError <pSocketID>, <pErrorString> |
| mouseWithin | Sent periodically to an object while the mouse pointer is within its borders. | mouseWithin |
| dragEnd | Sent to the object a drag and drop started from, when the data is dropped. | dragEnd |
| scrollbarEnd | Sent to a scrollbar when the user Shift-clicks its increase arrow. | scrollbarEnd <pEnd> |
| nameChanged | Sent to an object when its name is changed. | nameChanged <pOldName>, <pNewName> |
| dragDrop | Sent to the object where data was dropped when a drag and drop finishes. | dragDrop |
| newScrollbar | Sent to a new scrollbar right after it's created. | newScrollbar |
| scrollbarDrag | Sent to a field, scrollbar, or group when the user drags the scrollbar thumb or when a text selection causes a field to scroll. | scrollbarDrag <pNewPosition> |
| dragLeave | Sent when the mouse pointer moves out of an object during a drag and drop. | dragLeave |
| socketTimeout | Sent when an open socket, read from socket or write to socket command halts for the time specified by the socketTimeoutInterval property. | socketTimeout <pSocketID> |
| scrollbarBeginning | Sent to a scrollbar when the user Shift-clicks its decrease arrow. | scrollbarBeginning <pStart> |
| scrollbarLineDec | Sent to a scrollbar when the user clicks the decrease arrow, scrolling backward one line. | scrollbarLineDec <pNewPosition> |
| selectedObjectChanged | Sent to an object when it is selected. | selectedObjectChanged |
| dragEnter | Sent when the mouse pointer moves into an object during a drag and drop. | dragEnter |
| mouseRelease | Sent when the user releases the mouse outside the control that was clicked. | mouseRelease <pButtonNumber> |
| mouseDown | Sent when the user presses the mouse button. | mouseDown <pButtonNumber> |
| deleteScrollbar | Sent to a scrollbar just before it is removed from the stack. | deleteScrollbar |
| scrollbarPageInc | Sent to a scrollbar when the user clicks below or right of the scrollbar thumb, scrolling forward one screenful. | scrollbarPageInc <pNewPosition> |
| scrollbarLineInc | Sent to a scrollbar when the user clicks the increase arrow, scrolling forward one line. | scrollbarLineInc <pNewPosition> |
| mouseEnter | Sent when the mouse pointer moves into an object. | mouseEnter |
| mouseUp | Sent when the user releases the mouse button. | mouseUp <pButtonNumber> |
| dragMove | Sent when the user moves the mouse during a drag and drop. | dragMove |
| mouseStillDown | Sent periodically while the mouse button is being held down. | mouseStillDown <pButtonNumber> |
| scrollbarPageDec | Sent to a scrollbar when the user clicks above or left of the scrollbar thumb, scrolling backward one screenful. | scrollbarPageDec <pNewPosition> |
| dragStart | Sent to a control when the user clicked on it and then started to drag the mouse pointer. | dragStart |
| mouseMove | Sent when the user moves the mouse. | mouseMove <pNewMouseH>, <pNewMouseV> |
| resizeControl | Sent to a control right after the user resizes it. | resizeControl |
| mouseLeave | Sent when the mouse pointer moves out of an object. | mouseLeave |
| socketClosed | Sent when the remote system closes a socket. | socketClosed <pSocketID> |
| mouseDoubleUp | Sent when the mouse button is released at the end of a double-click. | mouseDoubleUp <pButtonNumber> |
| mouseDoubleDown | Sent when the user double-clicks. | mouseDoubleDown <pButtonNumber> |
Property
| Name | Summary | Syntax |
|---|---|---|
| topRight | Specifies the location of the specified object's upper right corner. | set the topRight of <object> to <right>, <top> |
| script | Specifies the contents of an object's **script**. | set the script of <object> to <string> |
| borderColor | Specifies the color of an object's border. | set the borderColor of <object> to {empty | <colorName> | <RGBColor>} set the borderColor of <line> of <field> to {empty | <colorName> | <RGBColor>} |
| hilitePixel | Specifies which entry in the color table is used for the background color when an object, or text in an object, is highlighted. | set the hilitePixel of <object> to <colorNumber> |
| patterns | Specifies all the patterns of an object, in shorthand form. | set the patterns of <object> to <patternsList> |
| number | Specifies an object's position within a file, a card's position within a stack, or a control's layer on a card. | set the number of <card> to <number> get the number of <object> |
| topLeft | Specifies the location of the specified object's upper left corner. | set the topLeft of <object> to left,top |
| altID | Specifies an alternate ID for objects. | set the altID of <object> to <IDNumber> |
| right | Specifies how far an object's right edge is from the left edge of the window or screen. | set the right of <object> to <pixels> |
| endValue | Specifies the value corresponding to a scrollbar's end position. | set the endValue of <scrollbar> to <number> |
| focusPattern | Specifies the pattern used for an object's outline when it has the insertion point or is active focused. | set the focusPattern of <object> to {<patternNumber> | <imageID> | empty} |
| topPattern | Specifies the pattern used to draw a three-D object's raised edge. | set the topPattern of <object> to {<patternNumber> | <imageID> | empty} |
| foregroundColor | Specifies the color of object text and borders. | set the foregroundColor of <object> to {empty | <colorName> | <RGBColor>} set the foregroundColor of [<chunk> of] <field> to {empty| <colorName> | <RGBColor>} |
| borderPixel | Specifies which entry in the color table is used for the color of an object's border. | set the borderPixel of <object> to <colorNumber> |
| shadowPixel | Specifies which entry in the color table is used for the color of an object's drop shadow or the background of a scrollbar. | set the shadowPixel of <object> to <colorNumber> |
| behavior | Allows an object to inherit its script handlers from another object. | set the behavior of <object> to {<button> | <stack>} |
| customProperties | Specifies all the custom properties of an object that are in the current customPropertySet, along with their settings. | set the customProperties of <object> to <propertiesArray> set the customProperties[<propertySet>] of <object> to <propertiesArray> |
| shadowColor | Specifies the color of an object's drop shadow or the background of a scrollbar. | set the shadowColor of <object> to {empty | <colorName> | <RGBColor>} |
| thumbPosition | Specifies the current position of a scrollbar's draggable thumb. | set the thumbPosition of <scrollbar> to <number> |
| textSize | Specifies the point size of text displayed by an object. | set the textSize of <object> to <pointSize> set the textSize of [<chunk> of] <field> to <pointSize> |
| shadowOffset | Specifies the size and direction of an object's drop shadow. | set the shadowOffset of <object> to <pixels> |
| textFont | Specifies the font face of text in an object. | set the textFont of <object> to <fontName> [, <language>] set the textFont of [<chunk> of] <field> to <fontName> [, <language>] |
| enabled | Specifies that an object is active and responds to user action. | set the enabled of <object> to {true | false} |
| backgroundColor | Specifies an object's background color. | set the backgroundColor of <object> to {empty | <colorName> | <RGBColor>} set the backgroundColor [of <chunk>] [of <line>] of <field> to {empty| <colorName> | <RGBColor>} |
| hiliteColor | Specifies the color of the background when an object, or text in an object, is highlighted. | set the hiliteColor [of <object>] to {empty | <colorName> | <RGBColor>} |
| dropShadow | Specifies the drop shadow to use for an object. | set the dropShadow of object to <propertiesArray> set the dropShadow[<propertyName>] of object to <propertyValue> |
| bottomPattern | Specifies the pattern of a three-D object's lowered edge. | set the bottomPattern of <object> to {empty | <patternNumber> | <imageID>} |
| customPropertySets | Lists all the custom property sets that can apply to an object. | get the customPropertySets of <object> |
| hilitePattern | Specifies the fill pattern used for the background when an object, or text in an object, is highlighted. | set the hilitePattern of <object> to {<patternNumber> | <imageID> | empty} |
| visible | Specifies whether an object can be seen or is hidden. | set the [effective] visible of <object> to {true | false} |
| shadowPattern | Specifies the pattern of an object's drop shadow. | set the shadowPattern of <object> to {<patternNumber> | <imageID> | empty} |
| layer | Specifies the back-to-front order of objects on a card or the order of cards in a stack. | set the layer of <object> to {<layerNumber> | top | bottom} |
| backgroundPattern | The **backgroundPattern** specifies the pattern used to draw an object's background. | set the backgroundPattern of <object> to {<patternNumber> | <imageID> | empty} |
| topColor | Specifies the color of a three-D object's raised edge. | set the topColor of <object> to {empty | <colorName> | <RGBColor>} |
| bottom | Specifies how far an object's bottom edge is from the top of the window or screen. | set the bottom of <object> to <number> |
| borderPattern | Specifies the pattern of an object's border. | set the borderPattern of <object> to {empty | <patternNumber> | <imageID>} |
| colorOverlay | Specifies the color overlay to use for an object. | set the colorOverlay of object to <propertiesArray> set the colorOverlay[<propertyName>] of object to <propertyValue> |
| orientation | Reports whether a scrollbar is vertical or horizontal--that is, whether its height or width property is greater. | get the orientation of <scrollbar> |
| height | Specifies the distance from an object's top edge to its bottom edge. | set the height of <object> to <numberOfPixels> |
| outerGlow | Specifies the outer glow to use for an object. | set the outerglow of object to <propertiesArray> set the outerglow[<propertyName>] of object to <propertyValue> |
| bottomPixel | Specifies which entry in the color table is used for the color of a three-D object's lowered edge. | set the bottomPixel of <object> to <colorNumber> |
| top | Specifies how far an object's top edge is from the top of the window or screen. | set the top of <object> to <numberOfPixels> |
| rectangle | Specifies the area within which an object is drawn. | set the rectangle of <object> to <left>, <top>, <right>, <bottom> get the [effective] rectangle of <object> |
| invisible | Specifies whether an object is hidden. | set the invisible of <object> to {true | false} get the [effective] invisible of <object> |
| layerMode | Specifies whether an object is dynamic or static. | set the layerMode of <object> to <mode> get the [effective] layerMode of <object> |
| topPixel | Specifies which entry in the color table is used for the color of a three-D object's raised edge. | set the topPixel of <object> to <colorNumber> |
| bottomRight | Specifies the location of the specified object's lower right corner. | set the bottomRight of <object> to right,bottom |
| foregroundPixel | Specifies which entry in the color table is used for an object's text and borders. | set the foregroundPixel of <object> to <colorNumber> |
| unicodeTooltip | Specifies the explanatory text (UTF-16 string) that pops up in a small box when the user points to an object. | set the unicodeTooltip of object to <unicodeString> |
| bottomLeft | Specifies the location of the specified object's lower left corner. | set the bottomLeft of <object> to <left>, <bottom> |
| innerShadow | Specifies the inner shadow to use for an object. | set the innerShadow of object to <propertiesArray> set the innerShadow[<propertyName>] of object to <propertyValue> |
| location | Specifies where an object is. | set the location of <object> to <point> |
| left | Specifies how far an object's left edge is from the left edge of the window or screen. | set the left of <object> to <numberOfPixels> |
| showFocusBorder | Displays a border around the active control. | set the showFocusBorder of <control> to {true | false} |
| disabled | Specifies that an object is dimmed and does not respond to user action. | set the disabled of <object> to {true | false} |
| pageIncrement | Specifies how far a scrollbar moves when the user clicks somewhere in its gray region. | set the pageIncrement of <scrollbar> to <pageAmount> |
| selected | Specifies whether an object is **selected**. | set the selected of <object> to {true | false} |
| showValue | Specifies whether the current value of a scale-bar scrollbar is displayed in below the scrollbar. | set the showValue of <scrollbar> to {true | false} |
| properties | Specifies some of an object's **properties** and their current values. | set the properties of <object> to <propertiesArray> |
| colors | Specifies all the colors of an object, in shorthand form. | set the colors of <object> to <colorsList> |
| ID | Reports the unique ID number assigned to an object. | set the ID of {image | stack} to <number> get the [{ long | abbreviated | short }] ID of <object> |
| customPropertySet | Specifies a set of custom properties applied to an object. | set the customPropertySet of object to {setName | empty} |
| lineIncrement | Specifies how far a scrollbar scrolls when one of its arrows is clicked. | set the lineIncrement of <scrollbar> to <distance> |
| startValue | Specifies the value corresponding to a scrollbar's start position. | set the startValue of <scrollbar> to <number> |
| backgroundPixel | Specifies which entry in the color table is used for an object's background color. | set the backgroundPixel of <object> to <colorNumber> |
| focusPixel | Specifies which entry in the color table is used for the color of an object's outline when it has the insertion point or is active focused. | set the focusPixel of <object> to <colorNumber> |
| thumbSize | Specifies how large a scrollbar's draggable thumb is. | set the thumbSize of <scrollbar> to <number> |
| bottomColor | Specifies the color of a three-D object's lowered edge. | set the bottomColor of <object> to {empty | <colorName> | <RGBColor>} |
| textStyle | Specifies the style or styles applied to text in an object. | set the textStyle of <object> to {empty | plain | <stylesList>} set the textStyle of [<chunk> of] <field> to {empty | plain | <stylesList>} set the textStyle[<style>] of object to {true | false} |
| threeD | Specifies whether an object appears to stick out of or recede into the screen. | set the threeD of <object> to {true | false} |
| width | The width of an object is the distance from its left edge to its right edge. | set the width of <object> to <numberOfPixels> |
| showBorder | Specifies whether an outline is drawn around an object. | set the showBorder of <object> to {true | false} |
| innerGlow | Specifies the inner glow to use for an object | set the innerGlow of object to <propertiesArray> set the innerGlow[<propertyName>] of object to <propertyValue> |
| name | Specifies the name of an object. | set the [{ long | abbreviated | short }] name of <object> to <string> get the name |
| owner | Reports which object is next in the object hierarchy. | get the [{ long | abbreviated | short }] owner of <object> |
| focusColor | Specifies the color of the outline around the active control or the field with the insertion point. | set the focusColor of <object> to {empty | <colorName> | <RGBColor>} |
| customKeys | Lists the names of all the custom properties of an object. | set the customKeys of <object> to {<propertiesList> | empty} |
| foregroundPattern | Specifies the pattern used for object text and borders. | set the foregroundPattern of <object> to {<patternNumber> | <imageID> | empty} set the foregroundPattern of [<chunk> of] <field> to {<patternNumber> | <imageID> | empty} |